[hdinsightonaks] Add command examples#8964
Conversation
️✔️Azure CLI Extensions Breaking Change Test
|
|
Hi @cxznmhdcxz, |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds an example section to the cluster node-profile create command help for the hdinsightonaks extension.
- Introduces an
examples:block under the command help. - Provides a single example showing how to create a node profile with specified SKU and worker count.
Comments suppressed due to low confidence (1)
src/hdinsightonaks/azext_hdinsightonaks/_help.py:21
- The example is missing required parameters such as
--resource-groupand--cluster-name; including these will ensure the example is executable by users.
examples:
| short-summary: Create a node profile with SKU and worker count. | ||
| examples: | ||
| - name: Create a node profile with SKU and worker count. | ||
| text: az hdinsight-on-aks cluster node-profile create --count 5 --node-type Worker --vm-size Standard_D16a_v4 |
There was a problem hiding this comment.
[nitpick] Consider using a YAML block scalar (e.g., text: >) for the example command to improve readability and prevent formatting issues with longer commands.
| text: az hdinsight-on-aks cluster node-profile create --count 5 --node-type Worker --vm-size Standard_D16a_v4 | |
| text: > | |
| az hdinsight-on-aks cluster node-profile create | |
| --count 5 | |
| --node-type Worker | |
| --vm-size Standard_D16a_v4 |
CodeGen Tools Feedback CollectionThank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey |
|
Hi @cxznmhdcxz Release SuggestionsModule: hdinsightonaks
Notes
|
This checklist is used to make sure that common guidelines for a pull request are followed.
Related command
General Guidelines
azdev style <YOUR_EXT>locally? (pip install azdevrequired)python scripts/ci/test_index.py -qlocally? (pip install wheel==0.30.0required)For new extensions:
About Extension Publish
There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update
src/index.jsonautomatically.You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify
src/index.json.